<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GIcon</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GIO Reference Manual">
<link rel="up" href="icons.html" title="Icons">
<link rel="prev" href="icons.html" title="Icons">
<link rel="next" href="GFileIcon.html" title="GFileIcon">
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="pt01.html" title="Part&#160;I.&#160;GIO Overview">
<link rel="chapter" href="ch01.html" title="Introduction">
<link rel="chapter" href="ch02.html" title="Compiling GIO applications">
<link rel="chapter" href="ch03.html" title="Running GIO applications">
<link rel="chapter" href="gio-extension-points.html" title="Extending GIO">
<link rel="part" href="pt02.html" title="Part&#160;II.&#160;API Reference">
<link rel="chapter" href="file_ops.html" title="File Operations">
<link rel="chapter" href="file_mon.html" title="File System Monitoring">
<link rel="chapter" href="async.html" title="Asynchronous I/O">
<link rel="chapter" href="streaming.html" title="Streaming I/O">
<link rel="chapter" href="types.html" title="File types and applications">
<link rel="chapter" href="volume_mon.html" title="Volumes and Drives">
<link rel="chapter" href="icons.html" title="Icons">
<link rel="chapter" href="utils.html" title="Utilities">
<link rel="chapter" href="extending.html" title="Extending GIO">
<link rel="part" href="migrating.html" title="Part&#160;III.&#160;Migrating to GIO">
<link rel="chapter" href="ch14.html" title="Migrating from POSIX to GIO">
<link rel="chapter" href="ch15.html" title="Migrating from GnomeVFS to GIO">
<link rel="chapter" href="gio-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="ix01.html" title="Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="icons.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="icons.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIO Reference Manual</th>
<td><a accesskey="n" href="GFileIcon.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2846388" class="shortcut">Top</a>
                  &#160;|&#160;
                  <a href="#id2876670" class="shortcut">Description</a>
                  &#160;|&#160;
                  <a href="#id2798931" class="shortcut">Object Hierarchy</a>
                  &#160;|&#160;
                  <a href="#id2876602" class="shortcut">Prerequisites</a>
                  &#160;|&#160;
                  <a href="#id2876623" class="shortcut">Known Derived Interfaces</a>
                  &#160;|&#160;
                  <a href="#id2876643" class="shortcut">Known Implementations</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GIcon"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2846388"></a><span class="refentrytitle">GIcon</span>
</h2>
<p>GIcon &#8212; Interface for icons</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">

#include &lt;gio/gio.h&gt;


                    <a class="link" href="GIcon.html#GIcon-struct">GIcon</a>;
                    <a class="link" href="GIcon.html#GIconIface">GIconIface</a>;
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</a>               <a class="link" href="GIcon.html#g-icon-hash">g_icon_hash</a>                         (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"
>gconstpointer</a> icon);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a class="link" href="GIcon.html#g-icon-equal">g_icon_equal</a>                        (<a class="link" href="GIcon.html" title="GIcon">GIcon</a> *icon1,
                                                         <a class="link" href="GIcon.html" title="GIcon">GIcon</a> *icon2);


</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2798931"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">

  GInterface
   +----GIcon
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2876602"></a><h2>Prerequisites</h2>
<p>
GIcon requires
 <a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2876623"></a><h2>Known Derived Interfaces</h2>
<p>
GIcon is required by
 <a class="link" href="GLoadableIcon.html" title="GLoadableIcon">GLoadableIcon</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2876643"></a><h2>Known Implementations</h2>
<p>
GIcon is implemented by
 <a class="link" href="GThemedIcon.html" title="GThemedIcon">GThemedIcon</a> and  <a class="link" href="GFileIcon.html" title="GFileIcon">GFileIcon</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2876670"></a><h2>Description</h2>
<p>
<a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> is a very minimal interface for icons. It provides functions 
for checking the equality of two icons and hashing of icons.
</p>
<p>
<a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> does not provide the actual pixmap for the icon as this is out 
of GIO's scope, however implementations of <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> may contain the name 
of an icon (see <a class="link" href="GThemedIcon.html" title="GThemedIcon"><span class="type">GThemedIcon</span></a>), or the path to an icon (see <a class="link" href="GLoadableIcon.html" title="GLoadableIcon"><span class="type">GLoadableIcon</span></a>). 
</p>
<p>
To obtain a hash of a <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>, see <a class="link" href="GIcon.html#g-icon-hash"><code class="function">g_icon_hash()</code></a>.
</p>
<p>
To check if two <span class="type">GIcons</span> are equal, see <a class="link" href="GIcon.html#g-icon-equal"><code class="function">g_icon_equal()</code></a>.</p>
<p>

</p>
</div>
<div class="refsect1" lang="en">
<a name="id2893364"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2893374"></a><h3>
<a name="GIcon-struct"></a>GIcon</h3>
<a class="indexterm" name="id2893386"></a><pre class="programlisting">typedef struct _GIcon GIcon;</pre>
<p>
An abstract type that specifies an icon.</p>
<p>

</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2893404"></a><h3>
<a name="GIconIface"></a>GIconIface</h3>
<a class="indexterm" name="id2893416"></a><pre class="programlisting">typedef struct {
  GTypeInterface g_iface;

  /* Virtual Table */

  guint               (*hash)               (GIcon                *icon);
  gboolean            (*equal)              (GIcon                *icon1,
					     GIcon                *icon2);
} GIconIface;
</pre>
<p>
GIconIface is used to implement GIcon types for various
different systems. See <a class="link" href="GThemedIcon.html" title="GThemedIcon"><span class="type">GThemedIcon</span></a> and <a class="link" href="GLoadableIcon.html" title="GLoadableIcon"><span class="type">GLoadableIcon</span></a> for
examples of how to implement this interface.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GTypeInterface"
>GTypeInterface</a>&#160;<em class="structfield"><code>g_iface</code></em>;</span></p></td>
<td> The parent interface.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code>hash</code></em>&#160;()</span></p></td>
<td> A hash for a given <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code>equal</code></em>&#160;()</span></p></td>
<td> Checks if two <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>s are equal.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2893523"></a><h3>
<a name="g-icon-hash"></a>g_icon_hash ()</h3>
<a class="indexterm" name="id2893535"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</a>               g_icon_hash                         (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"
>gconstpointer</a> icon);</pre>
<p>
Gets a hash for an icon.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>icon</code></em>&#160;:</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"
><span class="type">gconstpointer</span></a> to an icon object.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> a <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
><span class="type">guint</span></a> containing a hash for the <em class="parameter"><code>icon</code></em>, suitable for 
use in a <a
href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"
><span class="type">GHashTable</span></a> or similar data structure.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2893620"></a><h3>
<a name="g-icon-equal"></a>g_icon_equal ()</h3>
<a class="indexterm" name="id2893631"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            g_icon_equal                        (<a class="link" href="GIcon.html" title="GIcon">GIcon</a> *icon1,
                                                         <a class="link" href="GIcon.html" title="GIcon">GIcon</a> *icon2);</pre>
<p>
Checks if two icons are equal.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>icon1</code></em>&#160;:</span></p></td>
<td> pointer to the first <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>icon2</code></em>&#160;:</span></p></td>
<td> pointer to the second <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if <em class="parameter"><code>icon1</code></em> is equal to <em class="parameter"><code>icon2</code></em>. <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2893757"></a><div class="refsect2" lang="en"><a name="id2893758"></a></div>
<hr>
<div class="refsect2" lang="en"><a name="id2893759"></a></div>
</div>
</div>
</body>
</html>
